Scenario #1030: Add Operations Contact to Partner

UseCase Add Operations Contact To Partner => Operations-Contact: Dennis Krause for Test AG

Properties

Required

Given

name value
partnerPersonTradeName Test AG
operationsContactFamilyName Krause
operationsContactGivenName Dennis
operationsContactPhoneNumber +49 9932 587741
operationsContactEMailAddress dennis.krause@example.org

Person: Test AG

HTTP GET "/api/hs/office/persons?name=Test+AG" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "efe3662a-02d9-4fa9-a4f0-29dfd893fd78", // Person: Test AG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Test AG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one.

Person: Dennis Krause

HTTP POST "/api/hs/office/persons" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Krause",
  "givenName" : "Dennis"
}
EOF
=> status: 201 CREATED ac02b0a6-d581-4fc4-8b6f-6c02d1057bd7

Please check first if that person already exists, if so, use it’s UUID below.

HINT: operations contacts are always connected to a partner-person, thus a person which is a holder of a partner-relation.

Contact: Dennis Krause

HTTP POST "/api/hs/office/contacts" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "caption" : "Dennis Krause",
  "phoneNumbers" : {
    "main" : "+49 9932 587741"
  },
  "emailAddresses" : {
    "main" : "dennis.krause@example.org"
  }
}
EOF
=> status: 201 CREATED b294d7b0-eaa9-457b-945d-d2d6ce722dd4

Please check first if that contact already exists, if so, use it’s UUID below.

Create Operations-Contact: Dennis Krause for Test AG

HTTP POST "/api/hs/office/relations" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "efe3662a-02d9-4fa9-a4f0-29dfd893fd78", // Person: Test AG
  "holder.uuid" : "ac02b0a6-d581-4fc4-8b6f-6c02d1057bd7", // Person: Dennis Krause
  "contact.uuid" : "b294d7b0-eaa9-457b-945d-d2d6ce722dd4" // Contact: Dennis Krause
}
EOF
=> status: 201 CREATED 3499fb04-ed89-4bf5-a3f0-d8c4cb79c258

Verify the New OPERATIONS Relation

HTTP GET "/api/hs/office/relations?relationType=OPERATIONS&personData=Krause" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "3499fb04-ed89-4bf5-a3f0-d8c4cb79c258",
  "anchor" : {
    "uuid" : "efe3662a-02d9-4fa9-a4f0-29dfd893fd78", // Person: Test AG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Test AG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "ac02b0a6-d581-4fc4-8b6f-6c02d1057bd7", // Person: Dennis Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Dennis",
    "familyName" : "Krause"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "b294d7b0-eaa9-457b-945d-d2d6ce722dd4", // Contact: Dennis Krause
    "caption" : "Dennis Krause",
    "postalAddress" : { },
    "emailAddresses" : {
      "main" : "dennis.krause@example.org"
    },
    "phoneNumbers" : {
      "main" : "+49 9932 587741"
    }
  }
} ]

generated on 2026-08-10 04:42:23 for branch HEAD